Remove agent names and version constraints in MCP server documentation#479
Remove agent names and version constraints in MCP server documentation#479MervinPraison merged 1 commit intomainfrom
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe documentation for deploying and configuring MCP servers was updated. Explicit version constraints were removed from package installation commands. Example code snippets were reorganized and clarified: agent instantiations no longer include the Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello team, gemini-code-assist here to provide a summary of this pull request by @MervinPraison.
This PR focuses on updating the documentation for deploying and creating Model Context Protocol (MCP) servers. The primary changes involve removing specific version constraints for the praisonaiagents package in installation instructions and removing the explicit name parameter from Agent and Agents instantiation in the Python code examples provided in the documentation. Additionally, a new section is added to the mcp-server.mdx file to show a simpler multi-agent server setup without custom tools.
Highlights
- Documentation Updates: The pull request updates two documentation files related to MCP servers (
docs/deploy/mcp-server-deploy.mdxanddocs/mcp/mcp-server.mdx). - Removed Version Constraints: Specific version constraints (e.g.,
>=0.0.81) have been removed frompip installcommands for thepraisonaiagents[mcp]package in the documentation, simplifying installation instructions. - Removed Agent/Agents Names: The
nameparameter is removed from the instantiation ofAgentandAgentsclasses in the Python code examples within the documentation. This suggests that providing an explicit name might no longer be required or is being de-emphasized in these examples. - Added Simple Multi-Agent Example: A new section and code example for setting up a simple multi-agent MCP server without custom tools has been added to the
docs/mcp/mcp-server.mdxfile.
Changelog
Click here to see the changelog
- docs/deploy/mcp-server-deploy.mdx
- Removed version constraint
>=0.0.81frompip install "praisonaiagents[mcp]"commands (lines 18, 23). - Removed
name="TweetAgent"from the single agent example (line 33). - Removed
name="SearchAgent"andname="SummariseAgent"from the multi-agent example with custom tools (lines 55, 56). - Removed
name="MultiAgents"from theAgentsinstantiation in the multi-agent example with custom tools (line 58). - Added a new section titled "Simple Multi-Agent MCP Server" with corresponding code examples (added around line 62).
- Removed version constraint
>=0.0.81from thepraisonaiagents[mcp]entry in therequirements.txtexample (line 89).
- Removed version constraint
- docs/mcp/mcp-server.mdx
- Changed the title from "Creating MCP Servers" to "MCP Servers" (line 2).
- Removed
name="TweetAgent"from the single agent example (line 28). - Removed version constraint
>=0.0.81from thepip install "praisonaiagents[mcp]"command (line 48). - Removed
name="SearchAgent"andname="SummariseAgent"from the multi-agent example with custom tools (lines 68, 69). - Removed
name="MultiAgents"from theAgentsinstantiation in the multi-agent example with custom tools (line 71). - Added a new section titled "Multi-Agent MCP Server (Simple)" with corresponding code examples (added around line 84).
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Docs updated, clear and bright,
Names removed, a lighter sight.
Install now, no version fear,
MCP servers, drawing near.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
✅ Deploy Preview for praisonai ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Code Review
This pull request effectively simplifies the MCP server documentation by removing explicit version constraints for praisonaiagents in installation commands and by removing the optional name parameter from Agent and Agents instantiations in the examples. These changes make the documentation cleaner and encourage users to adopt the latest package versions.
The addition of a new "Simple Multi-Agent MCP Server" example in docs/mcp/mcp-server.mdx is a welcome improvement for clarity. However, there's a point of potential confusion in docs/deploy/mcp-server-deploy.mdx that needs addressing.
Summary of Findings
- Documentation Clarity: A redundant code block was identified in
docs/deploy/mcp-server-deploy.mdx, which could confuse users. This is detailed in a specific review comment. - Dependency Simplification: The removal of version constraints (e.g.,
>=0.0.81) frompip install praisonaiagents[mcp]commands is a good change, simplifying setup for users. - Example Code Simplification: Removing the optional
nameparameter fromAgentandAgentsinitializations in the examples makes them cleaner and focuses on essential parameters. - New Example Addition: The new 'Simple Multi-Agent MCP Server' example in
docs/mcp/mcp-server.mdx(and its intended counterpart indocs/deploy/mcp-server-deploy.mdx) is a valuable addition, showcasing a simpler multi-agent setup. - Minor Formatting Changes: Minor formatting changes, such as the removal of an extra blank line in
docs/deploy/mcp-server-deploy.mdxand a title adjustment indocs/mcp/mcp-server.mdx, were noted. These are low severity and not individually commented on per review settings.
Merge Readiness
The pull request introduces several positive changes to the documentation. However, there is a high-severity issue regarding a potentially redundant code block in docs/deploy/mcp-server-deploy.mdx that should be addressed to ensure clarity. I recommend that this issue be resolved before merging. As an AI reviewer, I am not authorized to approve pull requests; please ensure further review and approval by authorized maintainers.
| ```python | ||
| from praisonaiagents import Agent, Agents | ||
| from duckduckgo_search import DDGS | ||
|
|
||
| def internet_search_tool(query: str): | ||
| results = [] | ||
| ddgs = DDGS() | ||
| for result in ddgs.text(keywords=query, max_results=5): | ||
| results.append({ | ||
| "title": result.get("title", ""), | ||
| "url": result.get("href", ""), | ||
| "snippet": result.get("body", "") | ||
| }) | ||
| return results | ||
|
|
||
| agent = Agent(instructions="You Search the internet for information", tools=[internet_search_tool]) | ||
| agent2 = Agent(instructions="You Summarise the information") | ||
|
|
||
| agents = Agents(name="MultiAgents", agents=[agent, agent2]) | ||
| agents = Agents(agents=[agent, agent2]) | ||
| agents.launch(port=8080, host="0.0.0.0", protocol="mcp") | ||
| ``` |
There was a problem hiding this comment.
This code block (lines 74-94) appears to be identical to the 'Multi-Agent MCP Server with Custom Tools' example already present in this document (see lines 40-60).
Could you clarify if this duplication under the 'Simple Multi-Agent MCP Server' heading is intentional? If it's meant to illustrate something different, the surrounding explanation or the example itself might need adjustment. If it's redundant, removing it would help prevent potential confusion for users.
Remove agent names and version constraints in MCP server documentation
1 participant
Summary by CodeRabbit